Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add .devenv to projectRootsSearchExclude.default array #2643

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

jackdbd
Copy link

@jackdbd jackdbd commented Sep 30, 2024

What has changed?

This PR proposes a solution to the problem described in #2642 .

I just added .devenv to the projectRootsSearchExclude.default array.

Fixes #2642

My Calva PR Checklist

I have:

  • Read How to Contribute.
  • Directed this pull request at the dev branch. (Or have specific reasons to target some other branch.)
  • Made sure I have changed the PR base branch, so that it is not published. (Sorry for the nagging.)
  • Made sure there is an issue registered with a clear problem statement that this PR addresses, (created the issue if it was not present).
    • Updated the [Unreleased] entry in CHANGELOG.md, linking the issue(s) that the PR is addressing.
  • Figured if anything about the fix warrants tests on Mac/Linux/Windows/Remote/Whatever, and either tested it there if so, or mentioned it in the PR.
  • Added to or updated docs in this branch, if appropriate
  • Tests
    • Tested the particular change
    • Figured if the change might have some side effects and tested those as well.
  • Formatted all JavaScript and TypeScript code that was changed. (use the prettier extension or run npm run prettier-format)~
  • Confirmed that there are no linter warnings or errors (use the eslint extension, run npm run eslint before creating your PR, or run npm run eslint-watch to eslint as you go).~

Ping @PEZ, @bpringe, @corasaurus-hex, @Cyrik

Copy link

netlify bot commented Sep 30, 2024

Deploy Preview for calva-docs ready!

Name Link
🔨 Latest commit bf3d442
🔍 Latest deploy log https://app.netlify.com/sites/calva-docs/deploys/66faab1ae5541f0008422eea
😎 Deploy Preview https://deploy-preview-2643--calva-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@jackdbd jackdbd changed the title add .devenv to projectRootsSearchExclude add .devenv to projectRootsSearchExclude.default array Sep 30, 2024
@jackdbd jackdbd force-pushed the jack-in-should-ignore-devenv-profile branch from e6ff645 to 3e450a8 Compare September 30, 2024 09:28
@PEZ PEZ requested a review from bpringe September 30, 2024 10:31
CHANGELOG.md Outdated Show resolved Hide resolved
@PEZ
Copy link
Collaborator

PEZ commented Sep 30, 2024

Thanks for helping with making Calva better! 🙏

The change looks fine. I have added a small suggestion for CHANGELOG wording.

We do not merge changes that the author hasn't tested. I am assuming you have tested it, and are reading the checklist item as meaning “added automated tests”, which is not what it is about. Please confirm that you have tested the change.

Also for the formatting and linting, we appreciate that this is confirmed. If you are running the build task, these two things are taken care of, and you can check the outputs of the task to confirm. If you are not running the build task, you can check here for the PR build. It is tested in CI, so if CI says the build is cool, the formatting and linting passes: https://app.circleci.com/pipelines/github/BetterThanTomorrow/calva

Co-authored-by: Peter Strömberg <[email protected]>
@jackdbd
Copy link
Author

jackdbd commented Sep 30, 2024

I ran npm run eslint on my laptop and can confirm that it returns no errors if launched with the ESLint version declared in the package.json (8.8.0). Actually the first time I ran it using ESLint 9.x.x (9.11.1 if I remember correctly) and it returned a bunch of errors, but it's because they changed a couple of things in the config file and removed support for the --ext flag in the CLI.

I also ran npm run format-prettier on my laptop and it returns no errors.

As you mentioned in issue #2642 (comment), one could simply declare calva.projectRootsSearchExclude in .vscode/settings.json. That's how I tested that my "change" was working.

"calva.projectRootsSearchExclude": [
    ".cpcache",
    ".devenv",
    ".git",
    ".vscode"
  ]

I haven't yet tested it on my local version of Calva though. I have just started reading how to run Calva in development mode.

@jackdbd
Copy link
Author

jackdbd commented Sep 30, 2024

I have just realized that in docs/site/customizing-jack-in-and-connect.md this image should be updated, or maybe replaced with this JSON.

[
  "bower_components",
  ".bzr",
  ".cache",
  ".ccls-cache",
  ".clangd",
  ".classpath",
  "*.code-search",
  ".cpcache",
  "_darcs",
  ".devenv",
  ".DS_Store",
  ".ensime_cache",
  ".eunit",
  "flow-typed",
  "_FOSSIL_",
  ".fslckout",
  ".git",
  ".hg",
  ".idea",
  ".joyride",
  "node_modules",
  ".pijul",
  ".project",
  ".shadow-cljs",
  ".stack-work",
  ".svn",
  "target",
  ".tox",
  ".vscode"
]

We could run a small shell script or Babashka script before running mkdocs build -d docs/site. Something like this:

cat package.json | jq '.contributes.configuration[0].properties."calva.projectRootsSearchExclude".default' > docs/site/projectRootsSearchExclude.json

@PEZ
Copy link
Collaborator

PEZ commented Sep 30, 2024

I have just realized that in docs/site/customizing-jack-in-and-connect.md this image should be updated

Good point. It is better to remove the image, I think. I can do that later.

@PEZ
Copy link
Collaborator

PEZ commented Sep 30, 2024

I haven't yet tested it on my local version of Calva though. I have just started reading how to run Calva in development mode.

Cool. Holler when you've gotten that tested and we'll be merging this. Thanks again for the help with this!

@PEZ
Copy link
Collaborator

PEZ commented Dec 3, 2024

@jackdbd did you ever get to test this in your local dev env?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants